[beta] Update engine immobilizer state of a vehicle.

Update the engine immobilizer state of a vehicle. This requires an engine immobilizer to be installed on the vehicle gateway.

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Write Vehicle Immobilization under the Vehicles category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

PATCH /beta/fleet/vehicles/{id}/immobilizer

[beta] Update engine immobilizer state of a vehicle.

cURL

curl --request PATCH \
  --url https://api.samsara.com/beta/fleet/vehicles/{id}/immobilizer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "relayStates": [
    {
      "id": "relay1",
      "isOpen": false
    }
  ]
}
'

202

This response has no body data.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · integer<int64> · required

Vehicle ID

Body

application/json

A request body to update the engine immobilizer state.

relayStates · object[] · required

A list of relay states. If a relay is omitted, its state won't be updated. If the list is empty, a 400 bad request status code will be returned. If there are multiple states for the same relay, a 400 bad request status code will be returned.

Show child attributes

Response

202